AI Service > OCR > General OCR > APIガイド

General OCR API

リクエスト

  • {appKey}と{secretKey}はコンソール上部のURL & Appkeyメニューで確認できます。

[URI]

メソッド URI
POST https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/general

画像ファイルを利用したリクエスト

[リクエストヘッダ]

名前 値 説明
Authorization {secretKey} コンソールで発行されたセキュリティキー
Content-Type multipart/form-data コンテンツタイプ

[リクエスト本文]

  • 画像ファイルのBinary Dataを入れます。
curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/general' \
-F 'image=@sample.png' \
-H 'Authorization: ${secretKey}' \
-H 'Content-Type: multipart/form-data'

[フィールド]

名前 タイプ 説明
image multipart/form–data 画像ファイル

画像URLを利用したリクエスト

[リクエストヘッダ]

名前 値 説明
Authorization {secretKey} コンソールで発行されたセキュリティキー
Content-Type application/json コンテンツタイプ

[リクエスト本文]

  • 画像のURLを入れます。
curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/general' \
-H 'Authorization: ${secretKey}' \
-H 'Content-Type: application/json' \
--data '{ "imageUrl": "https://example.com/example.jpg" }'

[フィールド]

名前 タイプ 説明
imageUrl String 画像URL
  • イメージURLにポートを直接指定する場合は80、443、10000～12000ポートのみ使用できます。

レスポンス

[レスポンス本文]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "result": {
        "fileType": "png",
        "listOfInferTexts": [
            {
                "inferTexts": [
                    {
                        "value":"stella",
                        "conf":0.99
                    },
                    {
                        "value":"artois",
                        "conf":0.98
                    }
                ],
                "inferTexts": [
                    {
                        "value":"belgium",
                        "conf":0.99
                    }
                ]
            }
        ],
        "listOfBoundingBoxes": [
            {
                "boundingBoxes": [
                    {
                        "x1": 32,
                        "y1": 23,
                        "x2": 65,
                        "y2": 23,
                        "x3": 65,
                        "y3": 35,
                        "x4": 32,
                        "y4": 35
                    }
                ]
            }
        ]
    }
}

[ヘッダ]

名前 タイプ 説明
isSuccessful Boolean 分析APIの成否
resultCode Integer 結果コード
resultMessage String 結果メッセージ(成功時はsuccess、失敗時はエラー内容)

[フィールド]

名前 タイプ 説明
fileType String ファイル拡張子(jpg、png)
values List 認識結果リスト
listOfInferTexts[0].inferTexts[0].value String 認識内容
listOfInferTexts[0].inferTexts[0].conf Double 認識結果の信頼度
listOfBoundingBoxes List 認識領域(Bounding box)座標リスト
listOfBoundingBoxes[0].boundingBoxes[0] Object 認識領域の座標{ x1, y1, x2, y2, x3, y3, x4, y4 }
  • boxes[0] Bounding box

General OCR分割認識API

リクエスト

  • appKey} と {secretKey}はコンソール上部のURL & Appkeyメニューで確認できます。

[URI]

メソッド URI
POST https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/general/cropping

画像ファイルを利用したリクエスト

[リクエストヘッダ]

名前 値 説明
Authorization {secretKey} コンソールで発行されたセキュリティキー
Content-Type multipart/form-data コンテンツタイプ

[リクエスト本文]

  • 画像ファイルのバイナリデータを入れます。
curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/general/cropping' \
-F 'image=@sample.png' \
-H 'Authorization: ${secretKey}' \
-H 'Content-Type: multipart/form-data'

[フィールド]

名前 タイプ 説明
image multipart/form–data 画像ファイル

画像URLを利用したリクエスト

[リクエストヘッダ]

名前 値 説明
Authorization {secretKey} コンソールで発行されたセキュリティキー
Content-Type application/json コンテンツタイプ

[リクエスト本文]

  • 画像のURLを入れます。
curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/general/cropping' \
-H 'Authorization: ${secretKey}' \
-H 'Content-Type: application/json' \
--data '{ "imageUrl": "https://example.com/example.jpg" }'

[フィールド]

名前 タイプ 説明
imageUrl String 画像URL
  • イメージURLにポートを直接指定する場合は80、443、10000～12000ポートのみ使用できます。

レスポンス

[レスポンス本文]

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "result": {
        "fileType": "png",
        "listOfInferTexts": [
            {
                "inferTexts": [
                    {
                        "value":"stella",
                        "conf":0.99
                    },
                    {
                        "value":"artois",
                        "conf":0.98
                    }
                ],
                "inferTexts": [
                    {
                        "value":"belgium",
                        "conf":0.99
                    }
                ]
            }
        ],
        "listOfBoundingBoxes": [
            {
                "boundingBoxes": [
                    {
                        "x1": 32,
                        "y1": 23,
                        "x2": 65,
                        "y2": 23,
                        "x3": 65,
                        "y3": 35,
                        "x4": 32,
                        "y4": 35
                    }
                ]
            }
        ],
        "slicesImages": 2
    }
}

[ヘッダ]

名前 タイプ 説明
isSuccessful Boolean 分析APIの成否
resultCode Integer 結果コード
resultMessage String 結果メッセージ(成功時はsuccess、失敗時はエラー内容)

[フィールド]

名前 タイプ 説明
fileType String ファイル拡張子(jpg, png)
values List 認識結果リスト
listOfInferTexts[0].inferTexts[0].value String 認識内容
listOfInferTexts[0].inferTexts[0].conf Double 認識結果の信頼度
listOfBoundingBoxes List 認識領域(Bounding box)座標リスト
listOfBoundingBoxes[0].boundingBoxes[0] Object 認識領域座標{ x1, y1, x2, y2, x3, y3, x4, y4 }
slicesImages Integer 入力画像のアスペクト比に応じて内部的に分割された画像の数
  • boxes[0] Bounding box
目次
TOP